FlowPosition Methods
An object defining methods for the FlowPosition class.
SetPositionFromVariable(sourceVariable, sourceProperty)
Assigns a position to the flow position based on a variable and source property.
Parameters:
sourceVariable (required): Variable
The variable containing the position data.
sourceProperty (required): string
The property of the variable to use, such as value or text.
Returns:
Type: void
Method does not return anything
This is a sync method. Method runs synchronously.
SetReferredUser(user)
Sets a referred user for the flow position.
Parameters:
user (required): UserInfo
The user to set as the referred user.
Returns:
Type: void
Method does not return anything
This is a sync method. Method runs synchronously.
SetManagerUserAccordingToProfession(managerKey, professionName, targetPosition, sourcePosition, titleType, flowAssign)
Sets a manager user for the flow position according to profession criteria.
Parameters:
managerKey (required): string
The key identifying the manager profile.
professionName (required): string
The name of the profession.
targetPosition (required): FlowPosition
The target flow position.
sourcePosition (required): FlowPosition
The source flow position.
titleType (required): string
The type of title, such as constant or variable.
flowAssign (required): FlowAssign
The flow assignment details.
Returns:
Type: void
Method does not return anything
This is a sync method. Method runs synchronously.
GetUserInfo()
Retrieves the user information for the flow position.
Returns:
Type: UserInfo
Returns the user information for the flow position.
This is a sync method. Method runs synchronously.
SetConstantPosition(id, code, description)
Assigns a constant position to the flow position.
Parameters:
id (required): long
The unique identifier of the position.
code (required): string
The code of the position.
description (required): string
A description of the position.
Returns:
Type: void
Method does not return anything
This is a sync method. Method runs synchronously.
SetFromUser(userId)
Assigns a user to the flow position based on the user ID.
Parameters:
userId (required): long
The unique identifier of the user.
Returns:
Type: void
Method does not return anything
This is a sync method. Method runs synchronously.
SetFromPosition(positionId)
Assigns a position to the flow position based on the position ID.
Parameters:
positionId (required): long
The unique identifier of the position.
Returns:
Type: void
Method does not return anything
This is a sync method. Method runs synchronously.
SetUserFromVariable(sourceVariable)
Assigns a user to the flow position based on a variable.
Parameters:
sourceVariable (required): Variable
The variable containing the user ID.
Returns:
Type: void
Method does not return anything
This is a sync method. Method runs synchronously.
SetUserFromImpersonatingUser()
Sets the flow position user from the impersonating user.
Returns:
Type: void
Method does not return anything
This is a sync method. Method runs synchronously.
SetConstantPosition(constantPosition)
Assigns a constant position to the flow position using another flow position.
Parameters:
constantPosition (required): FlowPosition
The flow position containing constant position details.
Returns:
Type: void
Method does not return anything
This is a sync method. Method runs synchronously.
Initialize()
Initializes the flow position with default settings.
Returns:
Type: void
Method does not return anything
This is a sync method. Method runs synchronously.
SetUserFromFlowInitiator()
Sets the flow position user from the flow initiator.
Returns:
Type: void
Method does not return anything
This is a sync method. Method runs synchronously.
GetUserInfoWithPositionId()
Retrieves the user information along with the position ID for the flow position.
Returns:
Type: Task<UserInfoWithPositionId>
Returns a task that contains the user information along with the position ID for the flow position.
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
AddAttachment(value,type)
Adds an attachment to the mail message.
Parameters:
value (required): string
Value of the attachment.
type (required): MailAttachmentType
Type of the attachment.
Returns:
Type: void
Method does not return anything
This is a sync method. Method runs synchronously.
SetManagerUserFromUser(managerProfile, sourcePosition)
Assigns a manager user to the flow position based on a manager profile.
Parameters:
managerProfile (required): string
The key identifying the manager profile.
sourcePosition (required): FlowPosition
The source flow position.
Returns:
Type: void
Method does not return anything
This is a sync method. Method runs synchronously.
RemoveDocument(flowDocument)
Removes a document from the flow position.
Parameters:
flowDocument (required): FlowDocument
The document to remove.
Returns:
Type: bool
Returns true if the document was removed successfully, otherwise false.
This is a sync method. Method runs synchronously.
AddDocument(flowDocument, viewName, viewId, panelSize, allowEdit, showEvents)
Adds a document to the flow position with optional view and display settings.
Parameters:
flowDocument (required): FlowDocument
The document to add.
viewName (optional): string
The name of the view associated with the document.
viewId (optional): string
The identifier of the view.
panelSize (optional): PanelSize
The size of the document panel.
allowEdit (optional): bool
Determines if the document can be edited.
showEvents (optional): bool
Specifies if document events should be displayed.
Returns:
Type: bool
Returns true if the document was added successfully, otherwise false.
This is a sync method. Method runs synchronously.
SendPushNotification(userInfo,requestItem)
Sends a push notification to a user.
Parameters:
userInfo (required): UserInfo
The user to whom the push notification will be sent.
requestItem (required): ProcessRequestItem
The process request item associated with the notification.
Returns:
Type: void
Method does not return anything
This is a sync method. Method runs synchronously.
SetUserFromFlowInitiatorManager(managerKey)
Sets the flow position user from the flow initiator's manager.
Parameters:
managerKey (required): string
The key identifying the manager profile.
Returns:
Type: void
Method does not return anything
This is a sync method. Method runs synchronously.
SendApprovalWebNotification(userInfo, requestItem)
Sends a web notification for approval based on the provided process request and user information.
Parameters:
userInfo (required): UserInfo
The user information for the notification recipient.
requestItem (required): ProcessRequestItem
The process request item triggering the notification.
Returns:
Type: void
Method does not return anything
This is a sync method. Method runs synchronously.
SendRequestTimedOutWebNotification(userInfo, requestItem)
#import (Bimser.CSP.Workflow.Api.Steps.FlowGroup.SendRequestTimedOutWebNotification(UserInfo,ProcessRequestItem)) (shortDescription)
Parameters:
userInfo (required): UserInfo
Information about the user receiving the notification.
requestItem (required): ProcessRequestItem
The process request item associated with the notification.
This is a sync method. Method runs synchronously.
ToLiquid()
Converts the flow position into a format compatible with Liquid templates.
Returns:
Type: object
Returns the flow position as an object.
This is a sync method. Method runs synchronously.
SetUserFromLogonUser()
Sets the flow position user from the currently logged-on user.
Returns:
Type: void
Method does not return anything
This is a sync method. Method runs synchronously.
SetVariablePosition(position)
Assigns a variable position to the flow position using another flow position.
Parameters:
position (required): FlowPosition
The flow position containing variable position details.
Returns:
Type: void
Method does not return anything
This is a sync method. Method runs synchronously.
SetConstantUser(id, userName, fullName)
Assigns a constant user to the flow position.
Parameters:
id (required): long
The unique identifier of the user.
userName (required): string
The username of the user.
fullName (required): string
The full name of the user.
Returns:
Type: void
Method does not return anything
This is a sync method. Method runs synchronously.
SendMail(requestItem, userInfo)
Sends an email notification based on the provided process request and user information.
Parameters:
requestItem (required): ProcessRequestItem
The process request item triggering the email.
userInfo (required): UserInfo
The user information for the email recipient.
Returns:
Type: void
Method does not return anything
This is a sync method. Method runs synchronously.
SetDepartmentManagerUserFromDepartment(sourceDepartment)
Sets a department manager user for the flow position based on a department.
Parameters:
sourceDepartment (required): FlowDepartment
The department used to find the manager.
Returns:
Type: void
Method does not return anything
This is a sync method. Method runs synchronously.
SendWebNotification(payloadType,userInfo,requestItem)
Sends a web notification to a user.
Parameters:
payloadType (required): MessagePayloadType
The type of the web notification payload.
userInfo (required): UserInfo
The user to whom the web notification will be sent.
requestItem (required): ProcessRequestItem
The process request item associated with the notification.
Returns:
Type: void
Method does not return anything
This is a sync method. Method runs synchronously.